<meta charset="utf-8">
(#) Methods annotated with @RestrictedCallsTo should only be called from the specified scope

!!! ERROR: Methods annotated with @RestrictedCallsTo should only be called from the specified scope
   This is an error.

Id
:   `RestrictCallsTo`
Summary
:   Methods annotated with @RestrictedCallsTo should only be called from the specified scope
Severity
:   Error
Category
:   Correctness
Platform
:   Any
Vendor
:   slack
Identifier
:   slack-lint
Contact
:   https://github.com/slackhq/slack-lints
Feedback
:   https://github.com/slackhq/slack-lints
Min
:   Lint 8.7+
Compiled
:   Lint 8.7+
Artifact
:   [com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html)
Since
:   0.1.0
Affects
:   Kotlin and Java files and test sources
Editing
:   This check runs on the fly in the IDE editor
Implementation
:   [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/main/java/slack/lint/RestrictCallsToDetector.kt)
Tests
:   [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/RestrictCallsToDetectorTest.kt)
Copyright Year
:   2021

This method is intended to only be called from the specified scope
despite it being public. This could be due to its use in an interface or
similar. Overrides are still ok.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/foo/DifferentFile.kt:8:Error: Methods annotated with
@RestrictedCallsTo should only be called from the specified scope.
[RestrictCallsTo]
    api.annotatedExample()
    ----------------------
src/foo/DifferentFile.kt:15:Error: Methods annotated with
@RestrictedCallsTo should only be called from the specified scope.
[RestrictCallsTo]
    annotatedExample()
    ------------------
src/foo/DifferentFile.kt:26:Error: Methods annotated with
@RestrictedCallsTo should only be called from the specified scope.
[RestrictCallsTo]
    MyApiImpl().annotatedExample()
    ------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here are the relevant source files:

`src/foo/MyApi.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package foo

import slack.lint.annotations.RestrictCallsTo
import slack.lint.annotations.RestrictCallsTo.Companion.FILE

interface MyApi {
  fun example()

  @RestrictCallsTo(FILE)
  fun annotatedExample()
}

class SameFile {
  fun doStuffWith(api: MyApi) {
    // This is ok
    api.example()
    api.annotatedExample()
  }
}

class MyApiImpl : MyApi {
  override fun example() {
    annotatedExample()
  }

  // Note this is not annotated, ensures we check up the hierarchy
  override fun annotatedExample() {
    println("Hello")
  }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`src/foo/DifferentFile.kt`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers
package foo

class DifferentFile {
  fun doStuffWith(api: MyApi) {
    // This is ok
    api.example()
    // This is not
    api.annotatedExample()
  }
}

class MyApiImpl2 : MyApi {
  override fun example() {
    // Not ok
    annotatedExample()
  }

  // Still ok
  override fun annotatedExample() {
    println("Hello")
  }

  fun backdoor() {
    // Backdoors don't work either! This isn't annotated on the impl but we check the
    // original overridden type.
    MyApiImpl().annotatedExample()
  }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/RestrictCallsToDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `RestrictCallsToDetector.smokeTest`.
To report a problem with this extracted sample, visit
https://github.com/slackhq/slack-lints.

(##) Including

!!!
   This is not a built-in check. To include it, add the below dependency
   to your project. This lint check is included in the lint documentation,
   but the Android team may or may not agree with its recommendations.

```
// build.gradle.kts
lintChecks("com.slack.lint:slack-lint-checks:0.8.2")

// build.gradle
lintChecks 'com.slack.lint:slack-lint-checks:0.8.2'

// build.gradle.kts with version catalogs:
lintChecks(libs.slack.lint.checks)

# libs.versions.toml
[versions]
slack-lint-checks = "0.8.2"
[libraries]
# For clarity and text wrapping purposes the following declaration is
# shown split up across lines, but in TOML it needs to be on a single
# line (see https://github.com/toml-lang/toml/issues/516) so adjust
# when pasting into libs.versions.toml:
slack-lint-checks = {
    module = "com.slack.lint:slack-lint-checks",
    version.ref = "slack-lint-checks"
}
```

0.8.2 is the version this documentation was generated from;
there may be newer versions available.

[Additional details about com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html).
(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("RestrictCallsTo")
  fun method() {
     problematicStatement()
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("RestrictCallsTo")
  void method() {
     problematicStatement();
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection RestrictCallsTo
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="RestrictCallsTo" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'RestrictCallsTo'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore RestrictCallsTo ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>